Skip to content

Review 'Understand Logs and Metrics' doc #2306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Review 'Understand Logs and Metrics' doc #2306

wants to merge 2 commits into from

Conversation

@melissawm
Copy link
Contributor

@melissawm melissawm commented Sep 8, 2025 •
edited
Loading

Description

Follow-up to #2232

This PR includes some suggestions for the recently merged document "Understand Logs and Metrics".

A few notes:

  • I suggest using the "none" lexer for the code blocks here, since they don't actually represent code but outputs in the log. This causes the output to not be highlighted (as opposed to having distracting colors which are not useful in this context).
  • I have updated the links to the code to match the current structure with src/MaxText. I used permalinks, so hopefully this won't have to be done every single time code moves around the repo. However in this case I thought it was important since it's a completely new strucutre and the old links (while they work) might be confusing for readers.

Tests

Docs built successfully locally.

Checklist

Before submitting this PR, please make sure (put X in square brackets):

  • I have performed a self-review of my code.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • I have run end-to-end tests tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed.

@github-actions
Copy link

github-actions bot commented Oct 9, 2025

This PR has been automatically marked as stale because it has not had recent activity. It will be closed soon if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale Automatically applied to stale PRs. label Oct 9, 2025
@github-actions github-actions bot removed the stale Automatically applied to stale PRs. label Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gobbleturk gobbleturk Awaiting requested review from gobbleturk gobbleturk is a code owner

@khatwanimohit khatwanimohit Awaiting requested review from khatwanimohit

@bvandermoon bvandermoon Awaiting requested review from bvandermoon bvandermoon is a code owner

@vipannalla vipannalla Awaiting requested review from vipannalla vipannalla is a code owner

@RissyRan RissyRan Awaiting requested review from RissyRan RissyRan is a code owner

@richjames0 richjames0 Awaiting requested review from richjames0 richjames0 is a code owner

@gagika gagika Awaiting requested review from gagika gagika is a code owner

@shralex shralex Awaiting requested review from shralex shralex is a code owner

@yangyuwei yangyuwei Awaiting requested review from yangyuwei

@SurbhiJainUSC SurbhiJainUSC Awaiting requested review from SurbhiJainUSC

@hengtaoguo hengtaoguo Awaiting requested review from hengtaoguo

@A9isha A9isha Awaiting requested review from A9isha A9isha is a code owner

@aireenmei aireenmei Awaiting requested review from aireenmei

@NuojCheng NuojCheng Awaiting requested review from NuojCheng

@jacoguzo jacoguzo Awaiting requested review from jacoguzo jacoguzo is a code owner

@jiangjy1982 jiangjy1982 Awaiting requested review from jiangjy1982 jiangjy1982 is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@melissawm